Change vendor diagnostic codes to string type #362
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Tiyash Basu <[email protected]>
github-actions
bot
added
the
part:protobuf
tiyash-basu-frequenz
added
the
cmd:skip-release-notes
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the vendor diagnostic code fields in several microgrid component protos from a numeric type to a string, aligning examples and enabling more flexible vendor codes.
- Changed
vendor_diagnostic_codefromuint32tostringin three proto messages. - Updated inline JSON examples to show vendor codes as strings.
- (Consider: document breaking change and add tests.)
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| proto/frequenz/api/common/v1/microgrid/sensors/sensors.proto | Changed vendor_diagnostic_code to string; example JSON updated |
| proto/frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto | Changed vendor_diagnostic_code to string; example JSON updated |
| proto/frequenz/api/common/v1/microgrid/communication_components/communication_components.proto | Changed vendor_diagnostic_code to string; example JSON updated |
Comments suppressed due to low confidence (3)
proto/frequenz/api/common/v1/microgrid/sensors/sensors.proto:79
- The JSON example uses "vendorErrorCode" but the actual field is
vendor_diagnostic_code, which serializes tovendorDiagnosticCode. Update the example to match the field name.
// "vendorErrorCode": "2003",
proto/frequenz/api/common/v1/microgrid/sensors/sensors.proto:94
- Changing
vendor_diagnostic_codefromuint32tostringis a breaking change. Consider bumping the proto package version or adding migration notes for consumers.
optional string vendor_diagnostic_code = 2;
proto/frequenz/api/common/v1/microgrid/sensors/sensors.proto:94
- Add or update tests to verify serialization and deserialization of the new string-based
vendor_diagnostic_codevalues to prevent regressions.
optional string vendor_diagnostic_code = 2;
llucax
approved these changes
Jun 5, 2025
Merged
via the queue into
frequenz-floss:v0.x.x
with commit Jun 5, 2025
a70906d
6 of 7 checks passed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
closes #357